home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Gold Collection / Software Vault - The Gold Collection (American Databankers) (1993).ISO / cdr36 / lod370e.zip / CUSTOM.DOC < prev    next >
Text File  |  1993-01-15  |  21KB  |  472 lines

  1. Land Of Devastation Sysop Customization Manual
  2. ----------------------------------------------
  3.  
  4. By Scott M Baker
  5.  
  6. Section 1: Purpose
  7. ------------------
  8.        This manual is intended for sysops who wish to modify their Land
  9. Of Devastation games from the default setup. Land Of Devastation allows
  10. the sysop (or Game Master) to change almost every aspect of the game. You
  11. can create your own maps, monsters, weapons & armor, etc.
  12.  
  13. Section 2: Required files
  14. -------------------------
  15.        All of the files required for creating custom LOD games are
  16. contained in the archive LODxxxE.ARJ (with xxx representing the current
  17. LOD version number).
  18.  
  19. Section 3: Programs included
  20. ----------------------------
  21.        LOD includes several utilities to help you customize the game.
  22. These are:
  23.  
  24.        CUSTOM.EXE   - Customization editor. Used to edit some of the
  25.                       more complex fields of the game.
  26.  
  27.        COMPILE.EXE  - Used to compile a new game data set for LOD. (What
  28.                       is a data set? Look below!)
  29.  
  30. Section 4: Data Sets
  31. --------------------
  32.        To make things as easy as possible for both the customizer and
  33. the customizee (the poor guy who tries to run the customized version), LOD
  34. will "compile" most of the game data into a single "data set". This data
  35. set is contained in the file GAME.DEF. For most customized versions, the
  36. only file that needs to be changed is this GAME.DEF
  37.  
  38.        Basically, the data set (GAME.DEF) is a compiled package of the
  39. following text files:
  40.  
  41.        STRINGS.TXT - All of LOD's internal text strings
  42.        MONSTER.TXT - Monster definitions
  43.        COMBAT.TXT  - Combat strings (i.e. "You poke x's eye with your sword")
  44.        TALK.TXT    - Conversations of characters in Tavern & wasteland
  45.        TAVERN.TXT  - Tells who is in what tavern
  46.        TROYINFO.TXT- \
  47.        TRELLNOT.TXT-  > Special purpose text files
  48.        HISTORY.TXT - /
  49.        OBJECT.TXT  - Outlines the object of the game
  50.  
  51.        DATASET.TXT - Data Set identification & misc data
  52.  
  53.        The data set file (GAME.DEF) also includes the following binary
  54. files. These are NOT text files and may not be edited with a text editor. You
  55. must use the customization tool, CUSTOM.EXE to edit these files.
  56.  
  57.        MAIN.MAP    - The main game map
  58.        TERRAIN.BIN - Terrain definitions
  59.        MISC.BIN    - Miscellaneous stuff
  60.        DEVICES.BIN - Main device library
  61.  
  62.        As mentioned above, COMPILE.EXE will take all of those files and
  63. spit out one big GAME.DEF file from them. Therefore, you need not distribute
  64. any of the above text files - just the completed GAME.DEF.
  65.  
  66. Section 5: Locating the default text/binary files
  67. -------------------------------------------------
  68.        The default text and binary files are stored in the archive
  69. STANDARD.ARJ inside of LODxxxE.ARJ. Unarchive this file and it'll dump
  70. out strings.txt, monster.txt, combat.txt, main.map, devices.bin, and
  71. all of the other stuff. Then you can load these up and customize
  72. whatever you want according to section 6 below.
  73.  
  74. Section 6: Customizing the Text files
  75. -------------------------------------
  76.        What follows is a description of how to customize the text files
  77. listed in section four above. To edit these files, use any plain text
  78. editor.
  79.  
  80.   STRINGS.TXT: The master string file
  81.   -----------------------------------
  82.             Almost all of the text strings contained within LOD are taken
  83.      from this file. Everything from "you enter the tavern" to "what do you
  84.      wish to buy" to "there is new mail in the message system" is in here.
  85.      In fact, if you wanted to translate LOD into another language, once
  86.      you translated this one file, you would be about 80% done!
  87.  
  88.             Here's what to do:
  89.  
  90.             1) Load up STRINGS.TXT using any plain-ascii text editor. You can
  91.                now edit the strings and customize them as you wish. Please
  92.                note, the strings are specified one string to each line - if
  93.                you mess up this format, you could possibly shift all of the
  94.                strings and really screw things up. Here is the format:
  95.  
  96.                - Each line is one string definition in the game; So DO NOT
  97.                 DELETE OR INSERT LINES. You'll really mess things up.
  98.  
  99.                - A tilde (~) has been placed at the end of each line as a
  100.                  simple indicator to the user of where the line ends. (i.e.
  101.                  Otherwise lines that ended with a trailing space would be
  102.                  indistinguishable from lines that didn't)
  103.  
  104.                - The ampersand (&) is used to indicate the Land Of
  105.                  Devastation should change colors at that position. The "&"
  106.                  sign is followed by a hexadecimal digit, "0"-"F" specifying
  107.                  the color to change to.
  108.  
  109.                    &0 Black     &6 Brown         &C Light Red
  110.                    &1 Blue      &7 Light Gray    &D Light Magenta
  111.                    &2 Green     &8 Dark Gray     &E Yellow
  112.                    &3 Cyan      &9 Light Blue    &F White
  113.                    &4 Red       &A Light Green
  114.                    &5 Magenta   &B Light Cyan
  115.  
  116.               - The "|" sign is used to indicate a carriage return.
  117.  
  118.               - String may be up to 255 characters in length. (You could use
  119.                 one string entry with multiple "|"'s to specify multiple
  120.                 lines of text)
  121.  
  122.             2) Remember, just editing the file won't have any effect by
  123.                itself. You still need to run COMPILE.EXE to create a new
  124.                GAME.DEF file.
  125.  
  126.             So what needs to be edited in strings.txt? In reality, not a
  127.      whole lot. If you don't like the way something is said in the game
  128.      (or, heaven-forbid, you catch one of my ten thousand misspelled
  129.      words), you can change it. You'll find most of the fun work down
  130.      in the monsters.txt below.
  131.  
  132.   MONSTER.TXT: All the bad guys
  133.   -----------------------------
  134.             Here's where you will get a chance to have some fun. You can
  135.      create any monster you want in here. You can put him in any zone,
  136.      give him whatever weapons you want, and make up a nice description
  137.      of him.
  138.  
  139.             All of the instructions for editing monsters.txt are contained
  140.      at the top of the file. It's really pretty self explanatory - the best
  141.      thing to do is take one of the default monsters, and copy him to another
  142.      section of the file and make your changes to the copy.
  143.  
  144.   COMBAT.TXT: Combat strings
  145.   --------------------------
  146.             In the wasteland, we have all kinds of neat phrases for what
  147.       happens in combat. The combat.txt file is where it all is. Instructions
  148.       for this file are contained up at the top (like in the monster.txt
  149.       file). I'll leave it to you to look at the default stuff and figure
  150.       out how the format works.
  151.  
  152.   TALK.TXT: Character Dialog
  153.   --------------------------
  154.             No customized game is complete without a bunch of cool characters
  155.       that the player can talk to. Here is where you can decide what they
  156.       will say. You can make them say whatever you want and create
  157.       your own "keywords" that their responses will match.
  158.  
  159.             NOTE: If you create any new characters and want them placed in
  160.       a tavern, you will also have to edit the tavern.txt file below.
  161.  
  162.   TAVERN.TXT: People in Taverns
  163.   -----------------------------
  164.             This rather simple file just tells which players are in what
  165.       tavern. For example, say your create a character in the talk.txt file
  166.       above named "weird joe". If you want wierd joe to be in the freedom
  167.       city tavern, then you'll have to add an entry to this file to put
  168.       him there.
  169.  
  170.   TROYINFO.TXT: Troy Hadley's info file
  171.   -------------------------------------
  172.             One of the special quests ends up with the player receiving
  173.       a special rom-disk for his laptop which contains some hints on
  174.       locations, monsters, etc. This text file contains those hints. There's
  175.       no real format to this file - it's just a flat text file. If you
  176.       go moving towns around on the map, you'll probably have to change
  177.       some of the hints in here.
  178.  
  179.   TRELLNOT.TXT: Sergeant Trell's note
  180.   -----------------------------------
  181.             This is Sergeant Trell's note from the Tranlius Nuclear Facility.
  182.       If you want, you can edit it and change the theme a bit.
  183.  
  184.   HISTORY.TXT: History of the War
  185.   -------------------------------
  186.             There's a history rom that the players can get for their laptop.
  187.       It tells about the history of the nuclear war. This is it. Edit it to
  188.       your delight.
  189.  
  190.   OBJECT.TXT: Game Objectives
  191.   ---------------------------
  192.             This is a straight text file which should outline the object of
  193.       the game. Information on the central quest, etc. It is displayed by
  194.       the Game Objectives command in the documentation center of Sacre
  195.       Base.
  196.  
  197.   DATASET.TXT: Data set file
  198.   --------------------------
  199.             This contains some miscellanious "glue" information. Stuff
  200.       that needs to hold the whole package together, but doesn't really fit
  201.       in any of the other files above.
  202.  
  203.             Some minimal instructions are given inside the file - read them
  204.       and make your changes.
  205.  
  206.             The one important thing in here is the NAME and AUTHOR fields.
  207.       If you create a customized LOD data set, then you probably want to
  208.       give it a name and put yourself down as the author. This is where
  209.       you do it. The name/author information will appear on the WORLD
  210.       menu at the documentation center.
  211.  
  212. Section 7: Using CUSTOM.EXE
  213. ---------------------------
  214.        The external editor, NEWLODED.EXE, includes a variety of external editors
  215. and tools to allow the sysop to customize and configure his/her version of
  216. Land of Devastation. I will discuss each of the editor options in order
  217. below:
  218.  
  219.    UTILITIES
  220.         There are a few little utility features which will provide you with
  221.      some information about the game.
  222.  
  223.    EDITORS
  224.         Editors are included for device definitions, terrain, and the
  225.      wasteland map.
  226.  
  227.    SETUP
  228.         This section has options for configuring and setting up lod - what
  229.      new players start with, how much bases cost, etc.
  230.  
  231.      The external editor has an extensive context-sensitive help system which
  232.   can be of great use to you. Simply hit F1 at any time and a help window will
  233.   pop up.
  234.  
  235.  
  236.   NOTE #1: The external editor uses the TAB and SHIFT-TAB keys to move around
  237.            in some areas. Sometimes people find this difficult to understand,
  238.            but it is part of the design of the Turbo Vision tool kit which the
  239.            editor was written with.
  240.  
  241. Section 8: Editing Device Definitions
  242. -------------------------------------
  243.        To edit devices, you will need to use the Device Editor command under
  244. the Editors menu in CUSTOM.EXE.
  245.  
  246.        The following are a list of the various parameters that each device
  247. definition includes:
  248.  
  249.      NAME:     The name of the device; Should not be longer than 15 chars
  250.  
  251.      USES:     Number of uses LEFT on the device. Usually the same as MAXUSE
  252.      MAXUSE:   Maximum number of uses the device has.
  253.      DEV USE:  If "Y", then decrement the USES variable each time the
  254.                device is used.
  255.  
  256.      VAR1:     General purpose variable #1; varies from device to device.
  257.      VAR2:     General purpose variable #2; varies from device to device.
  258.  
  259.      APPLICAT: Code corresponding to what the device does.
  260.  
  261.      USABLE:   "Y" if the device can be used with the U command.
  262.  
  263.      STORE:    Code(s) corresponding to store at which device will be sold.
  264.      COST:     Price of device when sold at store.
  265.  
  266.      ANSI:     8 character string corresponding to attached ansi picture.
  267.      EGA:      Attached EGA graphics picture.
  268.  
  269.      Listing of APPLICAT codes:
  270.  
  271.      0 Radio         9 AML (medline)   18 Death Badge   27 Rom Disk
  272.      1 Medical Kit  10 Rope            19 Warper        28 <Internal>
  273.      2 SR Weapon    11 Rations         20 Communicator  29 B-Teleporter
  274.      3 LR Weapon    12 Scanner         21 B-React       30 Recharger
  275.      4 Armor        13 Stealth         22 B-Comm        31 Pylon Key
  276.      5 <reserved>   14 G-Blaster       23 B-Defense     32 Energy Cell
  277.      6 B.A.D.       15 Unusable Armor  24 B-Moat        33 Unitran
  278.      7 LRScan       16 Grenade         25 B-Weapon      34 Mine
  279.      8 Ammunition   17 Cyclops Eye     26 Laptop
  280.  
  281.      Listing of store codes:
  282.  
  283.      0 No Store      9 B-Weapon        18 Town #3
  284.      1 SR Weapons   10 Computer        19 Town #4
  285.      2 Armor        11 LR Weapons      20 Town #5
  286.      3 Supply       12 <internal>      21 Town #6
  287.      4 Ammo         13 <internal>      22 Town #7
  288.      5 B-React      14 GSRZ Hort.      23 Town #8
  289.      6 B-Comm       15 B-Teleporter    24 Town #9
  290.      7 B-Def        16 EEEE            25 Kill, Inc
  291.      8 B-Moat       17 Town #2
  292.  
  293.      Note: A device may be present at more than one store. If this is the
  294.            case, then list all of the store codes with SPACES inbetween
  295.            them. If a device is not to be present at any store, then leave
  296.            it's store line blank.
  297.  
  298.      Here are some of the definitions for the VAR1/VAR2 parameters for
  299.  some of the various device types.
  300.  
  301.      Weapons: The VAR1 parameter is divided into three fields corresponding
  302.               to the ammo type, minimum, and maximum damage. For example,
  303.               consider the following:
  304.  
  305.               NAME: Rad-Axe
  306.                 .
  307.                 .
  308.               VAR1: 32030
  309.                 .
  310.                 .
  311.  
  312.               The three fields are 3, 20, and 30. "3" is the ammo type;
  313.               20 is the minimum damage done and 30 is the maximum damage
  314.               done.
  315.  
  316.               For weapons not requiring ammo, use a "0" for the ammo type.
  317.               Always use two digit numbers (i.e. for a 4-6 damage weapon
  318.               requiring power packs, use 030406, NOT 0346)
  319.  
  320.         Ammo: The VAR1 parameter is the ammo type and the VAR2 parameter
  321.               is the number of shots. For example,
  322.  
  323.               NAME: Power Pack
  324.               VAR1: 3
  325.               VAR2: 35
  326.  
  327.               This is for a power pack - ammo type 3; 35 shots.
  328.  
  329.        Armor: The USELEFT parameter is the amount of damage the armor can
  330.               absorb; The VAR2 is the percentage chance of the armor
  331.               deflecting a hit. (i.e. VAR2=0 means the armor deflects
  332.               nothing; VAR2=100 means the armor deflects everything)
  333.  
  334.               The VAR1 parameter holds some specialty flags. These flags
  335.               are bit mapped. Right now, the flags are as follows:
  336.  
  337.                  Bit 1: If set, then armor is rechargable.
  338.  
  339.  Stlth Field: The SFG (Stealth Field Generator) uses both variables. VAR1
  340.               is 0 if neutral, 1 if noisy, or 2 if quiet. This should normally
  341.               be set to zero.
  342.  
  343.               VAR2 is the SFG's effectiveness. This is a percentage. The
  344.               higher the percentage, the more powerful the SFG is. The
  345.               default is 50.
  346.  
  347.         Mine: The VAR1 variable of the mine defines it's capabilities.
  348.               Example: 032035. The "03" indicates the mines capabilities,
  349.               the 20 is the minimum damage, and the 35 is the maximum
  350.               damage.
  351.  
  352.               Mine Capabilities: This is setup as a bitmap. Bit #1 is
  353.               for a smart mine, bit #2 is for a energy-drainer mine,
  354.               and bit #3 is for a teleporter mine.
  355.  
  356.               Mine Uses: the Useleft parameter tells how many charges
  357.               the mine contains.
  358.  
  359.  
  360.      Note: If/when I bring out a newer version of LOD, it will include a
  361.            replacement DEVICES.DEF file which will overwrite yours. For this
  362.            reason, it will be necessary for you to re-type your custom
  363.            device information back into device.def.
  364.  
  365.            Since I may also add devices to DEVICES.DEF in a future release,
  366.            it may be wise for you to place your custom entries from the
  367.            last position backwards to avoid conflicts with mine.
  368.  
  369. Section 9: Editing Terrain
  370. --------------------------
  371.        To edit Terrain, you will need to use the Terrain Editor option in
  372. the CUSTOM.EXE program.
  373.  
  374.        The terrain editor has the following parameters:
  375.  
  376.      NAME:     The name of the terrain type
  377.      DANGER:   Percentage chance of finding monster there.
  378.      SYMBOL:   2 character symbol for ansi/ascii maps
  379.      COLOR:    Numeric color code for ascii/ansi
  380.      PASSABLE: "Y" if you can walk through it. "N" if you can't.
  381.  
  382.        NOTE: For compatability (and simplicity) reasons, I would suggest
  383. that you stick with the standard terrain classes if at all possible. We've
  384. tried to throw in just about every possible kind of terrain you might want.
  385.  
  386. Section 10: Creating Trivia
  387. ---------------------------
  388.        You can create your own trivia questions if you use the same format
  389. as in TSAMP1.TXT. Name your text file "TRIVIA.TXT" and run TRIVCOMP to
  390. compile it into TRIVIA.DEF.
  391.  
  392.        A complete 300 question library is provided in the default TRIVIA.DEF
  393. file, but to make sure users don't get a hold of the questions, I had to
  394. keep the non-encrypted text version here!
  395.  
  396. Section 11: The GTSTRS.DEF file
  397. -------------------------------
  398.        Included with both GTERM and LOD, there is a GTSTRS.DEF file which
  399. defines the strings that will be used by the graphical interface. i.e. the
  400. help menus and screens inside the graphics window when using GAMEEGA
  401. or GTERM. Normally, there should be no reason to modify these strings. They
  402. were provided only for very extreme situations, such as the project to
  403. translate LOD into German.
  404.  
  405.        The format is very similar to LOD's strings.txt file, except that
  406. the color codes (&1, &2, ..., &F) are not allowed. You must have one
  407. string per line. You may not add or delete any lines. The "~" symbol is
  408. simply a marker for the end of each line - it is not actually displayed
  409. to the user.
  410.  
  411.        Both GAMEEGA and GTERM have seperate copies of this file. If you
  412. want remote users (with GTERM) to see the changes, then they will have
  413. to obtain their own copy of the file.
  414.  
  415. Section 12: Packaging Considerations
  416. ------------------------------------
  417.        For the purpose in maintaining some kind of standardization in naming
  418. conventions, this is what I would suggest. None of the following is
  419. required, but it establishind a standard really helps everyone out.
  420.  
  421.        1] Place your dataset (GAME.DEF, readme's, text files, whatever) into
  422.           an archive (.ARJ, .ZIP, etc) to keep all of the files together.
  423.  
  424.        2] For the name of your archive, use the following:
  425.  
  426.             a] First four letters identify your data set (i.e. STND for my
  427.                LOD standard data set)
  428.  
  429.             b] Next three letters indicate the version of LOD you compiled
  430.                the set for (i.e. 361)
  431.  
  432.             c] The last letter is a revision letter for your dataset (in case
  433.                you made changes and re-released). Start with "a" every time
  434.                you release for a new version of LOD, increment the indicator
  435.                every time you re-release YOUR data set for that version of
  436.                LOD.
  437.  
  438.             d] Of course, the extension would be .ZIP, .ARJ, .LZH, etc
  439.  
  440.             e] Examples:
  441.  
  442.                  STND361a.ARJ - LOD standard data set, for version 3.61,
  443.                                 revision "a".
  444.  
  445.                  FUTR395f.ARJ - FUTURE data set, compiled for LOD version
  446.                                 3.95, revision "f".
  447.  
  448.        3] Inside your archive, include the following files:
  449.  
  450.             README.TXT  -=-  Whatever you want in here - who you are, what
  451.                              the data set is about, special considerations,
  452.                              etc.
  453.  
  454.             GAME.DEF    -=-  The compiled dataset. The sysop just drops
  455.                              it in to use your data.
  456.  
  457.             ANSI.DEF    -=-  Optional. Only distribute if you modified some
  458.                              of the ansi screens.
  459.  
  460.             TRIVIA.DEF  -=-  Optional. Only distribute if you created some
  461.                              custom trivia.
  462.  
  463.             SOURCE.ARJ  -=-  The "source code" for your data set. All of
  464.                              your customized .TXT files (monster.txt,
  465.                              combat.txt, etc), your maps (MAIN.MAP), device
  466.                              definitions (devices.bin), etc. This is
  467.                              optional - only distribute it if you want
  468.                              other sysops to view/edit your data set.
  469.  
  470.  
  471.  
  472.